<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
<title>JdkFaultBarrierLogger xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/com/cerner/system/rest/retry/JdkFaultBarrierLogger.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em class="jxr_javadoccomment">/**</em>
<a name="2" href="#2">2</a>   <em class="jxr_javadoccomment"> * Copyright (c) 2009 Cerner Corporation.</em>
<a name="3" href="#3">3</a>   <em class="jxr_javadoccomment"> * All rights reserved. This program and the accompanying materials</em>
<a name="4" href="#4">4</a>   <em class="jxr_javadoccomment"> * are made available under the terms of the Eclipse Public License v1.0</em>
<a name="5" href="#5">5</a>   <em class="jxr_javadoccomment"> * which accompanies this distribution, and is available at</em>
<a name="6" href="#6">6</a>   <em class="jxr_javadoccomment"> * <a href="http://www.eclipse.org/legal/epl-v10.html" target="alexandria_uri">http://www.eclipse.org/legal/epl-v10.html</a></em>
<a name="7" href="#7">7</a>   <em class="jxr_javadoccomment"> *</em>
<a name="8" href="#8">8</a>   <em class="jxr_javadoccomment"> * Contributors:</em>
<a name="9" href="#9">9</a>   <em class="jxr_javadoccomment"> *    Cerner Corporation - initial API and implementation</em>
<a name="10" href="#10">10</a>  <em class="jxr_javadoccomment"> */</em>
<a name="11" href="#11">11</a>  <strong class="jxr_keyword">package</strong> com.cerner.system.<strong class="jxr_keyword">rest</strong>.retry;
<a name="12" href="#12">12</a>  
<a name="13" href="#13">13</a>  <strong class="jxr_keyword">import</strong> java.util.logging.Level;
<a name="14" href="#14">14</a>  <strong class="jxr_keyword">import</strong> java.util.logging.LogRecord;
<a name="15" href="#15">15</a>  <strong class="jxr_keyword">import</strong> java.util.logging.Logger;
<a name="16" href="#16">16</a>  
<a name="17" href="#17">17</a>  <strong class="jxr_keyword">import</strong> com.cerner.system.<strong class="jxr_keyword">rest</strong>.internal.arguments.NotNulls;
<a name="18" href="#18">18</a>  
<a name="19" href="#19">19</a>  <em class="jxr_javadoccomment">/**</em>
<a name="20" href="#20">20</a>  <em class="jxr_javadoccomment"> * JDK implementation of helper API that is used to log retry attempts. Log</em>
<a name="21" href="#21">21</a>  <em class="jxr_javadoccomment"> * messages are logged as {@link Level#INFO} in English.</em>
<a name="22" href="#22">22</a>  <em class="jxr_javadoccomment"> * </em>
<a name="23" href="#23">23</a>  <em class="jxr_javadoccomment"> * @author Alex Horn</em>
<a name="24" href="#24">24</a>  <em class="jxr_javadoccomment"> */</em>
<a name="25" href="#25">25</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../com/cerner/system/rest/retry/JdkFaultBarrierLogger.html">JdkFaultBarrierLogger</a> implements <a href="../../../../../com/cerner/system/rest/retry/FaultBarrierLogger.html">FaultBarrierLogger</a> {
<a name="26" href="#26">26</a>  
<a name="27" href="#27">27</a>    <em class="jxr_javadoccomment">/**</em>
<a name="28" href="#28">28</a>  <em class="jxr_javadoccomment">   * JDK logger facility</em>
<a name="29" href="#29">29</a>  <em class="jxr_javadoccomment">   */</em>
<a name="30" href="#30">30</a>    <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Logger logger;
<a name="31" href="#31">31</a>  
<a name="32" href="#32">32</a>    <em class="jxr_javadoccomment">/**</em>
<a name="33" href="#33">33</a>  <em class="jxr_javadoccomment">   * Default JDK {@link Logger} level with which abnormal activities are logged.</em>
<a name="34" href="#34">34</a>  <em class="jxr_javadoccomment">   */</em>
<a name="35" href="#35">35</a>    <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Level level;
<a name="36" href="#36">36</a>  
<a name="37" href="#37">37</a>    <em class="jxr_javadoccomment">/**</em>
<a name="38" href="#38">38</a>  <em class="jxr_javadoccomment">   * Constructor that allows the injection of a JDK logger facility. Subclasses</em>
<a name="39" href="#39">39</a>  <em class="jxr_javadoccomment">   * may wish to override the {@link #log(String, Throwable)} method to adjust</em>
<a name="40" href="#40">40</a>  <em class="jxr_javadoccomment">   * the severity or format of the log message.</em>
<a name="41" href="#41">41</a>  <em class="jxr_javadoccomment">   * </em>
<a name="42" href="#42">42</a>  <em class="jxr_javadoccomment">   * @param logger JDK logger used to report errors</em>
<a name="43" href="#43">43</a>  <em class="jxr_javadoccomment">   */</em>
<a name="44" href="#44">44</a>    <strong class="jxr_keyword">protected</strong> <a href="../../../../../com/cerner/system/rest/retry/JdkFaultBarrierLogger.html">JdkFaultBarrierLogger</a>(<strong class="jxr_keyword">final</strong> Logger logger, <strong class="jxr_keyword">final</strong> Level level) {
<a name="45" href="#45">45</a>      <strong class="jxr_keyword">this</strong>.logger = logger;
<a name="46" href="#46">46</a>      <strong class="jxr_keyword">this</strong>.level = level;
<a name="47" href="#47">47</a>    }
<a name="48" href="#48">48</a>  
<a name="49" href="#49">49</a>    <em class="jxr_javadoccomment">/**</em>
<a name="50" href="#50">50</a>  <em class="jxr_javadoccomment">   * Create a new {@link FaultBarrierLogger} that uses the JDK {@link Logger}</em>
<a name="51" href="#51">51</a>  <em class="jxr_javadoccomment">   * API to report errors in the specified {@link Level}.</em>
<a name="52" href="#52">52</a>  <em class="jxr_javadoccomment">   * </em>
<a name="53" href="#53">53</a>  <em class="jxr_javadoccomment">   * @throws IllegalArgumentException if JDK logger {@code level} argument is</em>
<a name="54" href="#54">54</a>  <em class="jxr_javadoccomment">   *           {@code null}</em>
<a name="55" href="#55">55</a>  <em class="jxr_javadoccomment">   */</em>
<a name="56" href="#56">56</a>    <strong class="jxr_keyword">static</strong> <a href="../../../../../com/cerner/system/rest/retry/FaultBarrierLogger.html">FaultBarrierLogger</a> create(<strong class="jxr_keyword">final</strong> Level level) {
<a name="57" href="#57">57</a>      NotNulls.names(<span class="jxr_string">"level"</span>).values(level);
<a name="58" href="#58">58</a>  
<a name="59" href="#59">59</a>      <strong class="jxr_keyword">final</strong> Logger defaultLogger = Logger.getLogger(FaultBarrier.<strong class="jxr_keyword">class</strong>.getName());
<a name="60" href="#60">60</a>      <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../com/cerner/system/rest/retry/JdkFaultBarrierLogger.html">JdkFaultBarrierLogger</a>(defaultLogger, level);
<a name="61" href="#61">61</a>    }
<a name="62" href="#62">62</a>  
<a name="63" href="#63">63</a>    <em class="jxr_javadoccomment">/**</em>
<a name="64" href="#64">64</a>  <em class="jxr_javadoccomment">   * Notify the logger facility that a failure has occurred.</em>
<a name="65" href="#65">65</a>  <em class="jxr_javadoccomment">   * </em>
<a name="66" href="#66">66</a>  <em class="jxr_javadoccomment">   * @param failure exception that caused the failure</em>
<a name="67" href="#67">67</a>  <em class="jxr_javadoccomment">   */</em>
<a name="68" href="#68">68</a>    <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> recover(<strong class="jxr_keyword">final</strong> Exception failure) {
<a name="69" href="#69">69</a>      log(<span class="jxr_string">"Encountered failure"</span>, failure);
<a name="70" href="#70">70</a>    }
<a name="71" href="#71">71</a>  
<a name="72" href="#72">72</a>    <em class="jxr_javadoccomment">/**</em>
<a name="73" href="#73">73</a>  <em class="jxr_javadoccomment">   * Notify the logger facility that the retry logic was unable to recover from</em>
<a name="74" href="#74">74</a>  <em class="jxr_javadoccomment">   * a failure.</em>
<a name="75" href="#75">75</a>  <em class="jxr_javadoccomment">   * </em>
<a name="76" href="#76">76</a>  <em class="jxr_javadoccomment">   * @param fatal cause of the unrecoverable error</em>
<a name="77" href="#77">77</a>  <em class="jxr_javadoccomment">   */</em>
<a name="78" href="#78">78</a>    <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> abort(<strong class="jxr_keyword">final</strong> Exception fatal) {
<a name="79" href="#79">79</a>      log(<span class="jxr_string">"Abort recovery"</span>, fatal);
<a name="80" href="#80">80</a>    }
<a name="81" href="#81">81</a>  
<a name="82" href="#82">82</a>    <em class="jxr_javadoccomment">/**</em>
<a name="83" href="#83">83</a>  <em class="jxr_javadoccomment">   * Log a server error message to the reporting facility that was injected at</em>
<a name="84" href="#84">84</a>  <em class="jxr_javadoccomment">   * instantiation.</em>
<a name="85" href="#85">85</a>  <em class="jxr_javadoccomment">   * </em>
<a name="86" href="#86">86</a>  <em class="jxr_javadoccomment">   * @param message human-readable message describing the nature of the error</em>
<a name="87" href="#87">87</a>  <em class="jxr_javadoccomment">   * @param cause cause that describes the nature of the runtime exception</em>
<a name="88" href="#88">88</a>  <em class="jxr_javadoccomment">   */</em>
<a name="89" href="#89">89</a>    <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> log(<strong class="jxr_keyword">final</strong> String message, <strong class="jxr_keyword">final</strong> Throwable cause) {
<a name="90" href="#90">90</a>      <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.logger.isLoggable(<strong class="jxr_keyword">this</strong>.level)) {
<a name="91" href="#91">91</a>        <strong class="jxr_keyword">final</strong> LogRecord record = <strong class="jxr_keyword">new</strong> LogRecord(<strong class="jxr_keyword">this</strong>.level, message);
<a name="92" href="#92">92</a>        record.setThrown(cause);
<a name="93" href="#93">93</a>        <strong class="jxr_keyword">this</strong>.logger.log(record);
<a name="94" href="#94">94</a>      }
<a name="95" href="#95">95</a>    }
<a name="96" href="#96">96</a>  
<a name="97" href="#97">97</a>  }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

